home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / mxclass.doc < prev    next >
Encoding:
Text File  |  2000-05-09  |  3.9 KB  |  234 lines
  1. TABLE OF CONTENTS
  2.  
  3. mxclass/--background--
  4. mxclass/MX_Active
  5. mxclass/MX_LabelPlace
  6. mxclass/MX_Labels
  7. mxclass/MX_TabsBackFill
  8. mxclass/MX_TabsObject
  9. mxclass/MX_TabsTextAttr
  10. mxclass/MX_TabsUpsideDown
  11. mxclass/MX_TabsBack(Dri)Pen
  12. mxclass/MX_Enable/DisableButton
  13.  
  14. mxclass/--background--
  15.  
  16. NAME
  17.  
  18.   Class: mxclass
  19.   Superclass: groupclass
  20.   Include File: <libraries/bgui.h>
  21.  
  22. FUNCTION
  23.  
  24.   To provide a gadget object similar to the gadtools.library's mx
  25.   kind. Objects from this class send out the following attribute pairs
  26.   in their notification events:
  27.  
  28.   GA_ID - Gadget object ID.
  29.   MX_Active - Currently selected label.
  30.  
  31. mxclass/MX_Active
  32.  
  33. NAME
  34.  
  35.   MX_Active -- ( ULONG )
  36.  
  37. FUNCTION
  38.  
  39.   Set or get the currently active (selected) button.
  40.  
  41. DEFAULT
  42.  
  43.   0.
  44.  
  45. APPLICABILITY
  46.  
  47.   (ISGNU).
  48.  
  49. mxclass/MX_LabelPlace
  50.  
  51. NAME
  52.  
  53.   MX_LabelPlace -- ( ULONG )
  54.  
  55. FUNCTION
  56.  
  57.   Set the place at which the labels of the button are placed. There are
  58.   two possibilities:
  59.  
  60.   PLACE_LEFT -- The labels are placed left of the buttons.
  61.   PLACE_RIGHT -- The labels are placed right of the buttons.
  62.  
  63. DEFAULT
  64.  
  65.   PLACE_RIGHT.
  66.  
  67. APPLICABILITY
  68.  
  69.   (I).
  70.  
  71. mxclass/MX_Labels
  72.  
  73. NAME
  74.  
  75.   MX_Labels -- ( STRPTR * )
  76.  
  77. FUNCTION
  78.  
  79.   Set the labels used by the radio-buttons. This must point to a
  80.   NULL-terminated array of string pointers. The strings will be the
  81.   labels of the buttons created by the class. This attribute must be
  82.   valid.
  83.  
  84. DEFAULT
  85.  
  86.   NULL.
  87.  
  88. APPLICABILITY
  89.  
  90.   (I).
  91.  
  92. mxclass/MX_TabsBackFill
  93.  
  94. NAME
  95.  
  96.   MX_TabsBackFill -- ( ULONG ) ** V40 **
  97.  
  98. FUNCTION
  99.  
  100.   To provide a backfill possibility the same as the frameclass supplies.
  101.   The data passed with this tag should be the same as defined and
  102.   documented for the FRM_BackFill attribute of the frameclass
  103.   documentation.
  104.  
  105.   The backfilling only affects the interior of the tab itself and only
  106.   the selected tab. Unselected tabs use the background color. The area
  107.   around the tab is affected by the groupclass attributes for
  108.   backfilling.
  109.  
  110. DEFAULT
  111.  
  112.   0.
  113.  
  114. APPLICABILITY
  115.  
  116.   (I).
  117.  
  118. SEE ALSO
  119.  
  120.   MX_TabsBackPen, MX_TabsBackDriPen
  121.  
  122. mxclass/MX_TabsObject
  123.  
  124. NAME
  125.  
  126.   MX_TabsObject -- ( BOOL )
  127.  
  128. FUNCTION
  129.  
  130.   To make the object a tabs object. A tabs object is an object which is
  131.   rendered similar to tabs in a book. When this attribute is set you
  132.   will  get  an object which is perfect to select pages from a pageclass
  133.   object.
  134.  
  135. DEFAULT
  136.  
  137.   FALSE.
  138.  
  139. APPLICABILITY
  140.  
  141.   (I).
  142.  
  143. mxclass/MX_TabsTextAttr
  144.  
  145. NAME
  146.  
  147.   MX_TabsTextAttr -- ( struct TextAttr * )
  148.  
  149. FUNCTION
  150.  
  151.   To determine the font in which the labels of the tabs are rendered.
  152.   NULL means that the font is the same as the font used by the other
  153.   objects in the window.
  154.  
  155. DEFAULT
  156.  
  157.   NULL.
  158.  
  159. APPLICABILITY
  160.  
  161.   (I).
  162.  
  163. mxclass/MX_TabsUpsideDown
  164.  
  165. NAME
  166.  
  167.   MX_TabsUpsideDown -- ( BOOL ) ** V40 **
  168.  
  169. FUNCTION
  170.  
  171.   To create a tabs object which should be placed below the pages to
  172.   select. It simply adjusts the framing imagery so that the tab will look
  173.   upside down.
  174.  
  175. DEFAULT
  176.  
  177.   FALSE.
  178.  
  179. APPLICABILITY
  180.  
  181.   (I).
  182.  
  183. mxclass/MX_TabsBack(Dri)Pen
  184.  
  185. NAME
  186.  
  187.   MX_TabsBackPen, MX_TabsBackDriPen -- ( ULONG ) ** V40 **
  188.  
  189. FUNCTION
  190.  
  191.   To determine the pen or DrawInfo pen which is used to back fill the
  192.   tabs. The data passed here should be the pen number of the color you
  193.   want to be used for the MX_TabsBackPen attribute.
  194.  
  195.   The MX_TabsBackDriPen attribute expects the DrawInfo index number to
  196.   be used to backfill the tabs.
  197.  
  198.   Specifying ~0 (-1) for the pens will deactivate the backfill color and
  199.   the class will use the BACKGROUNDPEN for the backfill.
  200.  
  201.   The backfilling only affects the interior of the tab itself and only
  202.   the selected tab. Unselected tabs use the background color. The area
  203.   around the tab is affected by the groupclass attributes for
  204.   backfilling.
  205.  
  206. DEFAULTS
  207.  
  208.   ~0.
  209.  
  210. APPLICABILITY
  211.  
  212.   (I).
  213.  
  214. SEE ALSO
  215.  
  216.   MX_TabsBackFill
  217.  
  218. mxclass/MX_Enable/DisableButton
  219.  
  220. NAME
  221.  
  222.   MX_EnableButton, MX_DisableButton -- ( ULONG )
  223.  
  224. FUNCTION
  225.  
  226.   Disable or enable a single button in the mx object. The data of these
  227.   tags must be the number of the button you wish to enable or disable.
  228.  
  229. APPLICABILITY
  230.  
  231.   (ISU).
  232.  
  233.  
  234.